home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3 / Vk / VkModifiedAttachment.z / VkModifiedAttachment
Encoding:
Text File  |  1998-10-20  |  10.1 KB  |  265 lines
  1.  
  2.  
  3.  
  4. VVVVkkkkMMMMooooddddiiiiffffiiiieeeeddddAAAAttttttttaaaacccchhhhmmmmeeeennnntttt((((3333xxxx))))                              VVVVkkkkMMMMooooddddiiiiffffiiiieeeeddddAAAAttttttttaaaacccchhhhmmmmeeeennnntttt((((3333xxxx))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      VkModifiedAttachment - Attachment class for showing modified text widgets
  10.  
  11. IIIINNNNHHHHEEEERRRRIIIITTTTSSSS FFFFRRRROOOOMMMM
  12.      VkModified :
  13.  
  14. HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
  15.      #include <Vk/VkModified.h>
  16.  
  17. PPPPUUUUBBBBLLLLIIIICCCC PPPPRRRROOOOTTTTOOOOCCCCOOOOLLLL SSSSUUUUMMMMMMMMAAAARRRRYYYY
  18.    CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrr////DDDDeeeessssttttrrrruuuuccccttttoooorrrr
  19.            VkModifiedAttachment(Boolean blankIsValue = False,
  20.                                 Boolean autoAdjust = True,
  21.                                 Boolean incrementalChange = False);
  22.            virtual void ~VkModifiedAttachment(void);
  23.  
  24.  
  25.    CCCCoooonnnnffffiiiigggguuuurrrraaaattttiiiioooonnnn
  26.            virtual void setParameters(Dimension width,
  27.                                       Dimension height);
  28.            void getParameters(Dimension* width, Dimension* height);
  29.            void attach(Widget w);
  30.            void detach(void);
  31.            void adjustGeometry(void);
  32.  
  33.  
  34.    AAAAcccccccceeeessssssss FFFFuuuunnnnccccttttiiiioooonnnnssss
  35.            Widget widget(void);
  36.  
  37.  
  38.    DDDDiiiissssppppllllaaaayyyy FFFFuuuunnnnccccttttiiiioooonnnnssss
  39.            void show(void);
  40.            void hide(void);
  41.            void expose(void);
  42.            void displayValue(void);
  43.  
  44.  
  45.  
  46.  
  47. XXXX RRRREEEESSSSOOOOUUUURRRRCCCCEEEESSSS AAAASSSSSSSSOOOOCCCCIIIIAAAATTTTEEEEDDDD WWWWIIIITTTTHHHH TTTTHHHHIIIISSSS CCCCLLLLAAAASSSSSSSS
  48.           displayModified                Whether to display the visual indicator (True)
  49.  
  50.  
  51. CCCCLLLLAAAASSSSSSSS DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  52.      The VkModifiedAttachment class is an attachment rather than a component.
  53.      You use the attach method to attach it to an existing text widget, and
  54.      then call the show method to make it visible.  Once visible,
  55.      VkModifiedAttachment will automatically display a "folded-corner" in the
  56.      upper-right of the text widget when the user changes the text value.  The
  57.      user can flip between previous and current text values by clicking in the
  58.      corner area.
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. VVVVkkkkMMMMooooddddiiiiffffiiiieeeeddddAAAAttttttttaaaacccchhhhmmmmeeeennnntttt((((3333xxxx))))                              VVVVkkkkMMMMooooddddiiiiffffiiiieeeeddddAAAAttttttttaaaacccchhhhmmmmeeeennnntttt((((3333xxxx))))
  71.  
  72.  
  73.  
  74.  
  75.  
  76. FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
  77.    VVVVkkkkMMMMooooddddiiiiffffiiiieeeeddddAAAAttttttttaaaacccchhhhmmmmeeeennnntttt(((())))
  78.            VkModifiedAttachment(Boolean blankIsValue = False,
  79.                                 Boolean autoAdjust = True,
  80.                                 Boolean incrementalChange = False);
  81.            virtual void ~VkModifiedAttachment(void);
  82.  
  83.  
  84.           The VkModifiedAttachment constructor creates an object capable of
  85.           attaching to a text widget and displaying modified-state information
  86.           to the user.  The user can click on the attachment area (the upper-
  87.           left corner) to alternate between previous and current text values.
  88.  
  89.           The first argument defaults to False and indicates whether a blank
  90.           (empty string) is considered a valid previous value when displaying
  91.           the folded corner.  The second argument defaults to True and
  92.           indicates whether VkModifiedAttachment automatically watches the
  93.           attached text widget for geometry changes and adjusts its own area
  94.           accordingly.  The last argument defaults to False and indicates
  95.           whether incremental character changes should trigger changes in the
  96.           display.
  97.  
  98.    sssseeeettttPPPPaaaarrrraaaammmmeeeetttteeeerrrrssss(((())))
  99.            virtual void setParameters(Dimension width,
  100.                                       Dimension height);
  101.  
  102.  
  103.           Adjusts VkModifiedAttachment display parameters.  The first is the
  104.           width of the attachment area, the second is the height.
  105.  
  106.    ggggeeeettttPPPPaaaarrrraaaammmmeeeetttteeeerrrrssss(((())))
  107.            void getParameters(Dimension* width, Dimension* height);
  108.  
  109.  
  110.           Returns VkModifiedAttachment display parameters.  The first is the
  111.           width of the attachment area, the second is the height.
  112.  
  113.    wwwwiiiiddddggggeeeetttt(((())))
  114.            Widget widget(void);
  115.  
  116.  
  117.           Returns the widget current attached to by the VkModifiedAttachment
  118.           object.
  119.  
  120.    aaaattttttttaaaacccchhhh(((())))
  121.            void attach(Widget w);
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. VVVVkkkkMMMMooooddddiiiiffffiiiieeeeddddAAAAttttttttaaaacccchhhhmmmmeeeennnntttt((((3333xxxx))))                              VVVVkkkkMMMMooooddddiiiiffffiiiieeeeddddAAAAttttttttaaaacccchhhhmmmmeeeennnntttt((((3333xxxx))))
  137.  
  138.  
  139.  
  140.           Attaches to a widget.  If already attached, first detaches from the
  141.           old widget.
  142.  
  143.    ddddeeeettttaaaacccchhhh(((())))
  144.            void detach(void);
  145.  
  146.  
  147.           Detaches from the current widget.  The attachment area, if visible,
  148.           is removed.
  149.  
  150.    sssshhhhoooowwww(((())))
  151.            void show(void);
  152.  
  153.  
  154.           Turn on display of the attachment area.  If the previous value
  155.           differs from the current value, a folder corner is displayed.  This
  156.           method has no effect if the "displayModified" resource is explicitly
  157.           set to False.
  158.  
  159.    hhhhiiiiddddeeee(((())))
  160.            void hide(void);
  161.  
  162.  
  163.           Turns off display of the attachment area.
  164.  
  165.    eeeexxxxppppoooosssseeee(((())))
  166.            void expose(void);
  167.  
  168.  
  169.           Force redrawing of the attachment area.  This gets called
  170.           automatically when Expose events are received.
  171.  
  172.    ddddiiiissssppppllllaaaayyyyVVVVaaaalllluuuueeee(((())))
  173.            void displayValue(void);
  174.  
  175.  
  176.           Change the text widget value to the last activated-value.
  177.  
  178.    aaaaddddjjjjuuuussssttttGGGGeeeeoooommmmeeeettttrrrryyyy(((())))
  179.            void adjustGeometry(void);
  180.  
  181.  
  182.           Force VkModifiedAttachment to reconfigure itself.  Applications
  183.           should call this after they change the geometry of the text widget,
  184.           unless autoAdjust is set to True.
  185.  
  186.    mmmmooooddddiiiiffffiiiieeeeddddCCCCaaaallllllllbbbbaaaacccckkkk
  187.            static const const char* modifiedCallback;
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. VVVVkkkkMMMMooooddddiiiiffffiiiieeeeddddAAAAttttttttaaaacccchhhhmmmmeeeennnntttt((((3333xxxx))))                              VVVVkkkkMMMMooooddddiiiiffffiiiieeeeddddAAAAttttttttaaaacccchhhhmmmmeeeennnntttt((((3333xxxx))))
  203.  
  204.  
  205.  
  206.           A callback function for detecting activation of the attached text
  207.           widget, or a value change in the text widget.  Use this callback
  208.           instead of installing your own XmNactivate or XmNvalueChanged
  209.           callbacks.  The _c_a_l_l_D_a_t_a argument should be cast to a (VkModified
  210.           *).
  211.  
  212. IIIINNNNHHHHEEEERRRRIIIITTTTEEEEDDDD MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNNSSSS
  213.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm VVVVkkkkMMMMooooddddiiiiffffiiiieeeedddd
  214.           VkModified(),  ~VkModified(),  blankIsValue(),  autoAdjust(),
  215.           modified(),  latestDisplay(), value(),  previousValue(),
  216.           updateModified(),  _modified,  _latest, _width,  _height,  _value,
  217.           _previousValue,  _blankIsValue, _autoAdjust,  _fixedPrevious,
  218.  
  219.  
  220. KKKKNNNNOOOOWWWWNNNN CCCCLLLLAAAASSSSSSSSEEEESSSS TTTTHHHHAAAATTTT UUUUSSSSEEEE TTTTHHHHIIIISSSS CCCCLLLLAAAASSSSSSSS
  221.      VkModifiedAttachment
  222.  
  223. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  224.      VkModified, VkModifiedAttachment,
  225.      _V_i_e_w_K_i_t _P_r_o_g_r_a_m_m_e_r'_s _G_u_i_d_e
  226.      _T_h_e _X _W_i_n_d_o_w _S_y_s_t_e_m, DEC Press, Bob Sheifler and Jim Gettys
  227.      _T_h_e _X _W_i_n_d_o_w _S_y_s_t_e_m _T_o_o_l_k_i_t, DEC Press, Paul Asente and Ralph Swick
  228.      _T_h_e _O_S_F/_M_o_t_i_f _P_r_o_g_r_a_m_m_e_r_s _R_e_f_e_r_e_n_c_e, Prentice Hall, OSF
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.